﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once

#include "GcmpDbCommonEdit.h"
#include "ElementId.h"
#include "IObject.h"

namespace gcmp {
    class IElement;
    class IDocument;
    class ICurve3d;
    class IPlane;

    /// \brief 对象的对齐组件的接口。
    class GCMP_DB_COMMON_EDIT_EXPORT IElementOffsetStrategy : public IObject
    {
        DEFINE_CAST_DERIVED(gcmp::IElementOffsetStrategy, gcmp::IObject);

    public:

        /// \brief 析构函数
        virtual ~IElementOffsetStrategy() {}

        /// \brief 对象的是否可偏移。
        /// 
        /// \param pElement 当前对象元素
        /// \param explanation 不可偏移时，可以返回原因。
        /// \return 可偏移则返回true；否则返回false。
        virtual bool CanBeOffset(const IElement* pElement, std::wstring* explanation) const = 0;

        /// \brief 对象的是否可以相连偏移。
        /// 
        /// \param pElement 当前对象元素
        /// \return 可相连偏移则返回true；否则返回false。
        virtual bool CanBeOffsetConnected(const IElement* pElement) const = 0;

        /// \brief 获取可以相连偏移的对象。
        /// 
        /// \param pElement 当前对象元素
        /// \return 返回所有可以相连偏移的对象的Id。
        virtual ElementIdArray GetElementsCanBeOffsetConnected(const IElement* pElement) const = 0;

        /// \brief 获取对象偏移操作的基准曲线。
        /// 
        /// \param pElement 当前对象元素
        /// \param pBasePlane 偏移的基准平面。
        /// \return 返回对象偏移操作的基准曲线。
        GCMP_DEPRECATED_API(2021 / 04 / 01) virtual OwnerPtr<ICurve3d> GetOffsetBaseCurve(const IElement* pElement, const IPlane* pBasePlane) const = 0;

        /// \brief 设置对象偏移操作后的基准曲线。
        /// 
        /// \param pElement 当前对象元素
        /// \param pBasePlane 偏移的基准平面。
        /// \param pCurve 偏移后的基准曲线。
        /// \return 设置成功则返回true；否则返回false。
        GCMP_DEPRECATED_API(2021 / 04 / 01) virtual bool SetOffsetBaseCurve(IElement* pElement, const IPlane* pBasePlane, const ICurve3d *pCurve) = 0;

        /// \brief 获取对象偏移操作的基准曲线。
        /// 
        /// \param pElement 当前对象元素
        /// \param pBasePlane 偏移的基准平面。
        /// \return 返回对象偏移操作的基准曲线。
        virtual std::vector<OwnerPtr<ICurve3d>> GetOffsetBaseCurves(const IElement* pElement, const IPlane* pBasePlane) const = 0;

        /// \brief 设置对象偏移操作后的基准曲线。
        /// 
        /// \param pElement 当前对象元素
        /// \param pBasePlane 偏移的基准平面。
        /// \param pCurve 偏移后的基准曲线。
        /// \return 设置成功则返回true；否则返回false。
        virtual bool SetOffsetBaseCurves(IElement* pElement, const IPlane* pBasePlane, const std::vector<const ICurve3d *>& vCurves) = 0;
    };

}// namespace gcmp


